Management API
Base Resource URL:
https://sandbox-portal.tidypay.com/api/v01/customers/[customer-id]/[subscriptions]
Description:
Allows to manage the subscriptions associated with the specified customer.
Available sub-resources:
| Resource URL | Description |
|---|---|
| https://sandbox-portal.tidypay.com/api/v01/customers/[customer-id]/[subscriptions]/[subscription-id] | Allows to manage the specified subscription. |
Supported Actions:
create
Parameters:
find
Parameters:
| Method: PUT | Implicit: Yes | Returns: Subscription * |
| Consumes: json, xml | Produces: json, xml | |
|
Creates a subscription.
|
||
Parameters:
| # | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
| 01 | object | Subscription * | Yes |
Information about the subscription transaction. |
find
| Method: GET | Implicit: Yes | Returns: Subscription[] * |
| Consumes: xurl | Produces: json, xml | |
|
Returns a list of available subscriptions.
|
||
Parameters:
| # | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
| 01 | offset | Integer | No | 0 |
Index of the first record returned to the customer from the search result of a web search. |
| 02 | limit | Integer | No | 100 |
Maximum number of records to load per single search web call made by the customer. |
| 03 | billingCycleType | String | No |
Type of a Billing Cycle used for filtering Subscription records. |
|
| 04 | createDateFrom | Date | No |
The beginning date for filtering Subscription records; only records dated from this specific day onwards are included. |
|
| 05 | createDateTo | Date | No |
The concluding date for filtering Subscription records; only records up to and through this specified date are included. |
|
| 06 | lastBillingDateFrom | Date | No |
The beginning date of the last billing date range for filtering billing records; only records dated from this specified day onwards are included. |
|
| 07 | lastBillingDateTo | Date | No |
The concluding date of the last billing date range for filtering billing records; only records up to and through this specified date are included. |
|
| 08 | nextBillingDateFrom | Date | No |
The beginning date of the next billing date range for filtering upcoming billing records; only future records dated from this specified day onwards are included. |
|
| 09 | nextBillingDateTo | Date | No |
The concluding date of the next billing date range for filtering upcoming billing records; only future records up to and through this specified date are included. |
|
| 10 | amountFrom | Integer | No |
The lower amount limit for filtering Subscription records; only those with values at or above this specified amount are included. |
|
| 11 | amountTo | Integer | No |
The upper amount limit for filtering Subscription records; only those with values up to and through this specified amount are included. |
|
| 12 | planId | Integer | No |
Plan ID used for filtering Subscription records. |
|
| 13 | type | String | No |
Type of the Subscription used for filtering Subscription records. |
|
| 14 | status | String | No |
Status of the Subscription used for filtering Subscription records. |
|
| 15 | name | String(255) | No |
Name of the Subscription used for filtering Subscription records. |
Copyright ©
TidyPay. All Rights Reserved.
All Logos and Trademarks used or mentioned on this page are copyrighted property of their respective owners and are used for display purposes only.